/*
 * Created on Apr 30, 2004
 * Created by Alon Rohter
 * Copyright (C) Azureus Software, Inc, All Rights Reserved.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */

package com.aelitis.azureus.core.peermanager.messaging.azureus;

import java.util.Map;

import org.gudy.azureus2.core3.util.DirectByteBuffer;

import com.aelitis.azureus.core.peermanager.messaging.Message;
import com.aelitis.azureus.core.peermanager.messaging.MessageException;
import com.aelitis.azureus.core.peermanager.messaging.MessagingUtil;

/**
 * This is a helper class for creating messages with a Map'd beencode-able payload.
 */
public class AZGenericMapPayload implements AZMessage {
    private final byte version;
    private DirectByteBuffer buffer = null;

    private final String type_id;
    private final Map msg_map;

    /**
     * Create a new AZ message with the given message type id, with the given bencode-able map payload.
     * 
     * @param message_type
     *            of message
     * @param message
     *            payload (to be bencoded)
     */
    public AZGenericMapPayload(String message_type, Map message, byte version) {
        this.type_id = message_type;
        this.msg_map = message;
        this.version = version;
    }

    public String getID() {
        return type_id;
    }

    public byte[] getIDBytes() {
        return type_id.getBytes();
    }

    public String getFeatureID() {
        return AZMessage.AZ_FEATURE_ID;
    }

    public int getFeatureSubID() {
        return AZMessage.SUBID_AZ_GENERIC_MAP;
    }

    public int getType() {
        return Message.TYPE_PROTOCOL_PAYLOAD;
    }

    public byte getVersion() {
        return version;
    };

    public Map getMapPayload() {
        return msg_map;
    }

    public String getDescription() {
        return getID();
    }

    public DirectByteBuffer[] getData() {
        if (buffer == null) {
            buffer = MessagingUtil.convertPayloadToBencodedByteStream(msg_map, DirectByteBuffer.AL_MSG);
        }
        return new DirectByteBuffer[] { buffer };
    }

    public Message deserialize(DirectByteBuffer data, byte version) throws MessageException {
        Map payload = MessagingUtil.convertBencodedByteStreamToPayload(data, 1, getID());
        return new AZGenericMapPayload(getID(), payload, version);
    }

    public void destroy() {
        if (buffer != null)
            buffer.returnToPool();
    }

}
